feat: add secureFieldsWithDetails 😋 #2241

zFernand0 · 2024-08-23T21:04:22Z

What It Does

Adds a new API to retrieve secureFields with more details
Fix Enhance secureFields method to optionally return arg value, type, and name #2206

How to Test

Review Checklist
I certify that I have:

tested my changes
added/updated automated tests
updated the changelog
followed the contribution guidelines

Additional Comments

// using config.api.secure.secureFields()
[
  'profiles.lpar1.profiles.zosmf.properties.user',
  'profiles.lpar1.profiles.zosmf.properties.test0', // unknown property (boolean)
  'profiles.lpar1.profiles.zosmf.properties.test1', // unknown property (number)
  'profiles.lpar1.profiles.zosmf.properties.test2', // unknown property (missing)
  'profiles.lpar1.properties.tokenValue', // let's assume that lpar1 is a typeless profile
  'profiles.base.properties.tokenValue', 
]

Here is what the output will look like in case we would like to reuse the same IProfArgAttrs interface.

[
  {
    "argName": "user",
    "dataType": "string",
    "argValue": "fernando",
    "argLoc": {
      "locType": 1,
      "osLoc": [
        "/Users/fernando/.zowe/zowe.config.json"
      ],
      "jsonLoc": "profiles.lpar1.profiles.zosmf.properties.user"
    }
  },
  {
    "argName": "test0",
    "dataType": "boolean",
    "argValue": false,
    "argLoc": {
      "locType": 1,
      "osLoc": [
        "/Users/fernando/.zowe/zowe.config.json"
      ],
      "jsonLoc": "profiles.lpar1.profiles.zosmf.properties.test0"
    }
  },
  {
    "argName": "test1",
    "dataType": "number",
    "argValue": 1234,
    "argLoc": {
      "locType": 1,
      "osLoc": [
        "/Users/fernando/.zowe/zowe.config.json"
      ],
      "jsonLoc": "profiles.lpar1.profiles.zosmf.properties.test1"
    }
  },
  {
    "argName": "test2",
    "dataType": null,
    "argValue": undefined,
    "argLoc": {
      "locType": 1,
      "osLoc": [
        "/Users/fernando/.zowe/zowe.config.json"
      ],
      "jsonLoc": "profiles.lpar1.profiles.zosmf.properties.test2"
    }
  },
  {
    "argName": "tokenValue",
    "dataType": null, // This is `null` because the lpar1 profile does not have a type
    "argValue": undefined,
    "argLoc": {
      "locType": 1,
      "osLoc": [
        "/Users/fernando/.zowe/zowe.config.json"
      ],
      "jsonLoc": "profiles.lpar1.properties.tokenValue"
    },
  {
    "argName": "tokenValue",
    "dataType": "string",
    "argValue": undefined,
    "argLoc": {
      "locType": 1,
      "osLoc": [
        "/Users/fernando/.zowe/zowe.config.json"
      ],
      "jsonLoc": "profiles.base.properties.tokenValue"
    }
  }
]

Signed-off-by: zFernand0 <[email protected]>

packages/imperative/src/config/src/api/ConfigSecure.ts

codecov · 2024-08-23T21:12:05Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.30%. Comparing base (35b9d47) to head (dc945c7).
Report is 3 commits behind head on next.

Additional details and impacted files

@@           Coverage Diff           @@
##             next    #2241   +/-   ##
=======================================
  Coverage   91.30%   91.30%           
=======================================
  Files         632      632           
  Lines       18147    18147           
  Branches     3888     3849   -39     
=======================================
  Hits        16570    16570           
  Misses       1576     1576           
  Partials        1        1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: zFernand0 <[email protected]>

traeok

Thanks Fernando! I left a suggestion for the opts parameter, but the implementation LGTM.

packages/imperative/src/config/src/ProfileInfo.ts

sonarqubecloud · 2024-08-27T14:51:25Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
97.1% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

awharn

Looks good to me, just have two little questions that don't need to be resolved.

awharn · 2024-08-28T17:09:44Z

packages/imperative/src/config/__tests__/Config.secure.unit.test.ts

+        config.mSecure = secureConfigs;
+        expect(config.api.secure.secureFieldsForLayer(projectConfigPath)).toEqual({ [securePropPath]: "area51" });
+        expect(config.api.secure.secureFieldsForLayer(projectUserConfigPath)).toEqual(null);
+        config.mSecure = {};


I know this is being a little picky, but is this line necessary for the locally scoped config variable?

awharn · 2024-08-28T17:11:33Z

packages/imperative/src/config/__tests__/ProfileInfo.TeamConfig.unit.test.ts

+                getPropAttr("rejectUnauthorized", undefined, "boolean"),
+            ]);
+
+            profInfo.getTeamConfig().mSecure = {};


Again, is this necessary for the locally scoped profInfo?

t1m0thyj · 2024-08-28T18:00:20Z

packages/imperative/src/config/src/api/ConfigSecure.ts

+     * @param layerPath Path of the layer to get secure properties for
+     * @returns the secure properties for the given layer, or null if not found
+     */
+    public secureFieldsForLayer(layerPath: string): IConfigSecureProperties {


Is adding this method necessary? I'm probably being dumb but it seems like the secureFields method has a layer parameter which can be used to filter the secure fields returned for only a specific layer.

feat: add secureFieldsWithDetails 😋

e6f738e

Signed-off-by: zFernand0 <[email protected]>

zFernand0 linked an issue Aug 23, 2024 that may be closed by this pull request

Enhance secureFields method to optionally return arg value, type, and name #2206

Closed

github-actions bot assigned zFernand0 Aug 23, 2024

github-advanced-security bot found potential problems Aug 23, 2024

View reviewed changes

packages/imperative/src/config/src/api/ConfigSecure.ts Fixed Show fixed Hide fixed

zFernand0 linked an issue Aug 26, 2024 that may be closed by this pull request

Nested configuration file issues seen by extenders zowe/zowe-explorer-vscode#2982

Closed

zFernand0 added 8 commits August 26, 2024 10:01

Use the IProfArgAttrs interface (tentative) 😋

7461902

Signed-off-by: zFernand0 <[email protected]>

update changelog

1b28916

Signed-off-by: zFernand0 <[email protected]>

Merge branch 'next' of https://github.com/zowe/zowe-cli into fix/ze-2982

d0e406c

Signed-off-by: zFernand0 <[email protected]>

audit: update dev dependency version 😋

9e77bf9

Signed-off-by: zFernand0 <[email protected]>

tests: rename function in ConfigSecure and add unit tests 😋

cf06aa0

Signed-off-by: zFernand0 <[email protected]>

fix: simplify both APIs adn added unit test 😋

7139287

Signed-off-by: zFernand0 <[email protected]>

Merge branch 'next' of https://github.com/zowe/zowe-cli into fix/ze-2982

23dec8a

Signed-off-by: zFernand0 <[email protected]>

fix: add types to all missing arguments based on schema definition

ed4498a

Signed-off-by: zFernand0 <[email protected]>

zFernand0 marked this pull request as ready for review August 26, 2024 18:46

zFernand0 requested review from t1m0thyj, traeok, gejohnston, janan07 and awharn August 26, 2024 18:46

zFernand0 added 3 commits August 26, 2024 15:44

Merge branch 'next' into fix/ze-2982

4eafe92

Merge branch 'next' of https://github.com/zowe/zowe-cli into fix/ze-2982

35b9d47

Signed-off-by: zFernand0 <[email protected]>

Merge branch 'next' of https://github.com/zowe/zowe-cli into fix/ze-2982

dc945c7

Signed-off-by: zFernand0 <[email protected]>

janan07 approved these changes Aug 27, 2024

View reviewed changes

traeok approved these changes Aug 27, 2024

View reviewed changes

packages/imperative/src/config/src/ProfileInfo.ts Show resolved Hide resolved

zFernand0 mentioned this pull request Aug 27, 2024

Add default behavior for user/global layer lookup #2247

Closed

awharn approved these changes Aug 28, 2024

View reviewed changes

t1m0thyj reviewed Aug 28, 2024

View reviewed changes

traeok merged commit fa7bcd4 into next Aug 29, 2024
46 checks passed

traeok deleted the fix/ze-2982 branch August 29, 2024 15:08

traeok added the release-current Indicates that there is no new functionality being delivered label Aug 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add secureFieldsWithDetails 😋 #2241

feat: add secureFieldsWithDetails 😋 #2241

zFernand0 commented Aug 23, 2024 •

edited

Loading

codecov bot commented Aug 23, 2024 •

edited

Loading

traeok left a comment

sonarqubecloud bot commented Aug 27, 2024

awharn left a comment

awharn Aug 28, 2024

awharn Aug 28, 2024 •

edited

Loading

t1m0thyj Aug 28, 2024

feat: add secureFieldsWithDetails 😋 #2241

feat: add secureFieldsWithDetails 😋 #2241

Conversation

zFernand0 commented Aug 23, 2024 • edited Loading

codecov bot commented Aug 23, 2024 • edited Loading

Codecov Report

traeok left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Aug 27, 2024

Quality Gate passed

awharn left a comment

Choose a reason for hiding this comment

awharn Aug 28, 2024

Choose a reason for hiding this comment

awharn Aug 28, 2024 • edited Loading

Choose a reason for hiding this comment

t1m0thyj Aug 28, 2024

Choose a reason for hiding this comment

zFernand0 commented Aug 23, 2024 •

edited

Loading

codecov bot commented Aug 23, 2024 •

edited

Loading

awharn Aug 28, 2024 •

edited

Loading